home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / NDK / NDK_3.5 / Documentation / Autodocs / page_gc.doc < prev    next >
Encoding:
Text File  |  1999-10-29  |  4.2 KB  |  133 lines
  1. TABLE OF CONTENTS
  2.  
  3. page_gc/--datasheet--
  4. page_gc/PAGE_GetClass
  5. page_gc/RefreshPageGadget
  6. page_gc/SetPageGadgetAttrsA
  7. page_gc/--datasheet--                                   page_gc/--datasheet--
  8.  
  9.   NAME
  10.       page.gadget -- a gadget for easy creation of GUI pages.
  11.  
  12.   SUPERCLASS
  13.       gadgetclass
  14.  
  15.   DESCRIPTION
  16.       Page gadget takes a list of BOOPSI objects and treats each as a
  17.       single page of a multi-page GUI group. Used together with
  18.       tabs.gadget and layout.gadget, it allows complex GUI layouts with
  19.       hidden objects with virtually no work for the developer.
  20.  
  21.       This gadget class is contained within the layout.gadget binary.
  22.       Thus, you will need to OpenLibrary layout.gadget, but not
  23.       page.gadget.
  24.  
  25.   METHODS
  26.       GM_DOMAIN
  27.       GM_RENDER
  28.       GM_LAYOUT
  29.       DTM_PROCLAYOUT
  30.       OM_SET
  31.       OM_UPDATE
  32.       OM_NEW
  33.       OM_DISPOSE
  34.  
  35.       All other methods are passed to the currently visible object.
  36.  
  37.   ATTRIBUTES
  38.       PAGE_Add (Object *)
  39.           A BOOPSI gadget (probably a layout.gadget) to add to the end of
  40.           the page list.
  41.  
  42.           Applicability is (OM_NET, OM_SET)
  43.  
  44.       PAGE_Remove (Object *)
  45.           Pointer to a gadget to remove from the page list. page.gadget
  46.           will automatically dispose all attached objects when disposed of.
  47.  
  48.           Applicability is (OM_SET)
  49.  
  50.       PAGE_Current (ULONG)
  51.           Sets/gets the currently visible page. Note that OM_SET will NOT
  52.           trigger a rerender, call RethinkLayout() afterwards. OM_UPDATE
  53.           will rerender automatically.
  54.  
  55.           Applicability is (OM_NEW, OM_SET, OM_UPDATE)
  56.  
  57.       PAGE_FixedVert, PAGE_FixedHoriz (BOOL)
  58.           Like the respective tags of layout.gadget, these will, if set
  59.           to FALSE, force the group's dimensions to the smallest possible
  60.           in the respective direction.
  61.  
  62.           Applicability is (OM_NEW, OM_SET, OM_UPDATE)
  63.  
  64.   SEE ALSO
  65.       layout.gadget/--datasheet--
  66.       ReAction example source for usage.
  67. page_gc/PAGE_GetClass                                   page_gc/PAGE_GetClass
  68.  
  69.   NAME
  70.       PAGE_GetClass -- Gets the pointer to the Page class.
  71.  
  72.   SYNOPSIS
  73.       page_class = PAGE_GetClass();
  74.       D0
  75.  
  76.       Class * PAGE_GetClass(VOID);
  77.  
  78.   FUNCTION
  79.       Obtains the pointer to the page gadget class for use with
  80.       NewObject().  This function always returns a valid pointer so
  81.       you do not need to check it.  The reason is that if the library
  82.       opens fine, then the pointer returned is already setup.  (Of course
  83.       this implies that if opening the library fails, you shouldn't be
  84.       calling this.)
  85.  
  86.       Note that this function does not create the class, that is done
  87.       when the class library is opened.
  88.  
  89.   INPUTS
  90.       Nothing.
  91.  
  92.   NOTES
  93.       PAGE_GetClass() is contained in layout.gadget. There is no PageBase,
  94.       just LayoutBase.
  95.  
  96.   RESULT
  97.       page_class - Pointer to the page gadget class.
  98. page_gc/RefreshPageGadget                           page_gc/RefreshPageGadget
  99.  
  100.    NAME
  101.        RefreshPageGadget -- Refresh gadget in a paged layout
  102.    
  103.    SYNOPSIS
  104.        RefreshPageGadget(gad, page, win, req)
  105.                          A0     A1       A2   A3
  106.    
  107.        void RefreshPageGadget(struct Gadget *, Object *, 
  108.                struct Window *, struct Requester *)
  109.                
  110.    FUNCTION
  111.        Like RefreshGList(gad,win,req,1), but passes a NULL window and 
  112.        requester pointer if the gadget is not on the currently visible 
  113.        page.
  114. page_gc/SetPageGadgetAttrsA                       page_gc/SetPageGadgetAttrsA
  115.  
  116.    NAME
  117.        SetPageGadgetAttrsA -- Set gadget attributes in a paged layout
  118.        SetPageGadgetAttrs -- Varargs stub for SetPageGadgetAttrsA
  119.    
  120.    SYNOPSIS
  121.        value = SetPageGadgetAttrsA(gad, page, win, req, tags)
  122.        D0                            A0     A1       A2   A3   A4
  123.    
  124.        ULONG SetPageGadgetAttrsA(struct Gadget *, Object *, 
  125.                struct Window *, struct Requester *, struct TagItem *)
  126.                
  127.        ULONG SetPageGadgetAttrs(struct Gadget *, Object *, 
  128.                struct Window *, struct Requester *, ULONG, ...)
  129.  
  130.    FUNCTION
  131.        Like SetGadgetAttrs, but passes a NULL window and requester pointer
  132.        if the gadget is not on the currently visible page.
  133.